Document gdk_toplevel_set_modal

diff --git a/gdk/gdktoplevel.c b/gdk/gdktoplevel.c
index 1cfeb2c448afd056183b73f3bf3641393a22386d..7544b673a201e426d8ab4ed6ff6af4fa786b6edd 100644 (file)
--- a/gdk/gdktoplevel.c
+++ b/gdk/gdktoplevel.c
@@ -352,6 +352,19 @@ gdk_toplevel_set_transient_for (GdkToplevel *toplevel,
   g_object_set (toplevel, "transient-for", parent, NULL);
 }
 
+/**
+ * gdk_toplevel_set_modal:
+ * @toplevel: A toplevel surface
+ * @modal: %TRUE if the surface is modal, %FALSE otherwise.
+ *
+ * The application can use this hint to tell the
+ * window manager that a certain surface has modal
+ * behaviour. The window manager can use this information
+ * to handle modal surfaces in a special way.
+ *
+ * You should only use this on surfaces for which you have
+ * previously called gdk_toplevel_set_transient_for().
+ */
 void
 gdk_toplevel_set_modal (GdkToplevel *toplevel,
                         gboolean     modal)